/*
 * Copyright 2016-2017 Huawei Technologies Co., Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.openo.sdnhub.osdriverservice.dao.inf;

import java.util.List;

import org.openo.baseservice.remoteservice.exception.ServiceException;
import org.openo.sdnhub.osdriverservice.openstack.client.OpenStackClient;

/**
 *
 * DAO  class interface<br>
 * <p>
 * </p>
 *
 * @param <T>
 * @author
 * @version SDNHUB 0.5 August 6, 2016
 */
public interface IDao<T> {

    /**
     * Adds OverlayUnderlayMapping
     * <br>
     *
     * @param entity
     * @return
     * @throws ServiceException
     * @since  SDNHUB 0.5
     */
    T insert(T entity) throws ServiceException ;

    /**
     * Delete OverlayUnderlayMapping
     * <br>
     *
     * @param clazz
     * @param uuid
     * @throws ServiceException
     * @since  SDNHUB 0.5
     */
    void delete(Class<T> clazz, String uuid) throws ServiceException;

    /**
     * Get OverlayUnderlayMapping
     * <br>
     *
     * @param clazz
     * @param uuid
     * @return
     * @throws ServiceException
     * @since  SDNHUB 0.5
     */
    T get(Class<T> clazz, String uuid) throws ServiceException;

    /**
     * Find children of given OverlayUnderlayMapping's overlay id
     * <br>
     *
     * @param clazz
     * @param overlayId
     * @return
     * @throws ServiceException
     * @since  SDNHUB 0.5
     */
    List<T> getChildren(Class<T> clazz, String overlayId) throws ServiceException;
}
